home *** CD-ROM | disk | FTP | other *** search
/ STraTOS 1997 April & May / STraTOS 1 - 1997 April & May.iso / CD01 / SYSTEMS / OAESIS / DOC / MODELS.TXT < prev    next >
Encoding:
Text File  |  1996-01-16  |  3.1 KB  |  72 lines
  1. A few things to think about:
  2.  
  3. 1. Do _not_ use TAB when writing comments. Since the length of TABs
  4.    vary the comments might be practically unreadable on other systems.
  5. 2. Try not to put extern definitions in .c-files. This might lead to "hard
  6.    to find" bugs. Put such definitions in .h-files.
  7.  
  8. ------------------------
  9. Standard function header
  10. ------------------------
  11.  
  12. /****************************************************************************
  13.  * noname                                                                   *
  14.  *  This is a layout for c function headers to be used in oaesis            *
  15.  ****************************************************************************/
  16. int               /*                                                        */
  17. noname(           /*                                                        */
  18. int var1,         /*                                                        */
  19. int var2 )        /*                                                        */
  20. /****************************************************************************/
  21.  
  22. ----------------------
  23. Standard module header
  24. ----------------------
  25.  
  26. /****************************************************************************
  27.  
  28.  Module
  29.   something.c
  30.   
  31.  Description
  32.   A deeper description
  33.   
  34.  Author(s)
  35.      cg (Christer Gustavsson <d2cg@dtek.chalmers.se>)
  36.      etc
  37.      
  38.  Revision history
  39.  
  40.   951224 cg
  41.    What has been done?
  42.  
  43.  Copyright notice
  44.   The copyright to the program code herein belongs to the authors. It may
  45.   be freely duplicated and distributed without fee, but not charged for.
  46.  
  47.  ****************************************************************************/
  48.  
  49. /****************************************************************************
  50.  * Used interfaces                                                          *
  51.  ****************************************************************************/
  52.  
  53. /****************************************************************************
  54.  * Macros                                                                   *
  55.  ****************************************************************************/
  56.  
  57. /****************************************************************************
  58.  * Typedefs of module global interest                                       *
  59.  ****************************************************************************/
  60.  
  61. /****************************************************************************
  62.  * Module global variables                                                  *
  63.  ****************************************************************************/
  64.  
  65. /****************************************************************************
  66.  * Local functions (use static!)                                            *
  67.  ****************************************************************************/
  68.  
  69. /****************************************************************************
  70.  * Public functions                                                         *
  71.  ****************************************************************************/
  72.